<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>Test2::API::InterceptResult - Representation of a list of events. - Perldoc Browser</title>
    <link rel="search" href="https://perldoc.perl.org/opensearch.xml" type="application/opensearchdescription+xml" title="Perldoc Browser">
    <link rel="canonical" href="https://perldoc.perl.org/Test2::API::InterceptResult">
    <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css" integrity="sha384-JcKb8q3iqJ61gNV9KGb8thSsNjpSL0n8PARn9HuZOnIxN0hoP+VmmDGMN5t9UJ0Z" crossorigin="anonymous">
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/stackoverflow-light.min.css" integrity="sha512-cG1IdFxqipi3gqLmksLtuk13C+hBa57a6zpWxMeoY3Q9O6ooFxq50DayCdm0QrDgZjMUn23z/0PMZlgft7Yp5Q==" crossorigin="anonymous" />
    <style>
      body {
        background: #f4f4f5;
        color: #020202;
      }
      .navbar-dark {
        background-image: -webkit-linear-gradient(top, #005f85 0, #002e49 100%);
        background-image: -o-linear-gradient(top, #005f85 0, #002e49 100%);
        background-image: linear-gradient(to bottom, #005f85 0, #002e49 100%);
        filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff005f85', endColorstr='#ff002e49', GradientType=0);
        background-repeat: repeat-x;
      }
      .navbar-dark .navbar-nav .nav-link,
      .navbar-dark .navbar-nav .nav-link:focus { color: #fff }
      .navbar-dark .navbar-nav .nav-link:hover { color: #ffef68 }
      #wrapperlicious {
        margin: 0 auto;
        font: 0.9em 'Helvetica Neue', Helvetica, sans-serif;
        font-weight: normal;
        line-height: 1.5em;
        margin: 0;
        padding: 0;
      }
      #wrapperlicious h1 { font-size: 1.5em }
      #wrapperlicious h2 { font-size: 1.3em }
      #wrapperlicious h3 { font-size: 1.1em }
      #wrapperlicious h4 { font-size: 0.9em }
      #wrapperlicious h1, #wrapperlicious h2, #wrapperlicious h3,
      #wrapperlicious h4, #wrapperlicious dt {
        color: #020202;
        margin-top: 1em;
        margin-bottom: 1em;
        position: relative;
        font-weight: bold;
      }
      #wrapperlicious a { color: inherit; text-decoration: underline }
      #wrapperlicious #toc { text-decoration: none }
      #wrapperlicious a:hover { color: #2a2a2a }
      #wrapperlicious a img { border: 0 }
      #wrapperlicious :not(pre) > code {
        color: inherit;
        background-color: rgba(0, 0, 0, 0.04);
        border-radius: 3px;
        font: 0.9em Consolas, Menlo, Monaco, monospace;
        padding: 0.3em;
      }
      #wrapperlicious dd {
        margin: 0;
        margin-left: 2em;
      }
      #wrapperlicious dt {
        color: #2a2a2a;
        font-weight: bold;
        margin-left: 0.9em;
      }
      #wrapperlicious p {
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious li > p {
        margin-bottom: 0;
        margin-top: 0;
      }
      #wrapperlicious pre {
        border: 1px solid #c1c1c1;
        border-radius: 3px;
        font: 100% Consolas, Menlo, Monaco, monospace;
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious pre > code {
        display: block;
        background-color: #f6f6f6;
        font: 0.9em Consolas, Menlo, Monaco, monospace;
        line-height: 1.5em;
        text-align: left;
        white-space: pre;
        padding: 1em;
      }
      #wrapperlicious dl, #wrapperlicious ol, #wrapperlicious ul {
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious ul {
        list-style-type: square;
      }
      #wrapperlicious ul ul {
        margin-bottom: 0px;
        margin-top: 0px;
      }
      #footer {
        font-size: 0.8em;
        padding-top: 0.5em;
        text-align: center;
      }
      #more {
        display: inline;
        font-size: 0.8em;
      }
      #perldocdiv {
        background-color: #fff;
        border: 1px solid #c1c1c1;
        border-bottom-left-radius: 5px;
        border-bottom-right-radius: 5px;
        margin-left: auto;
        margin-right: auto;
        padding: 3em;
        padding-top: 1em;
        max-width: 960px;
      }
      #moduleversion { float: right }
      #wrapperlicious .leading-notice {
        font-style: italic;
        padding-left: 1em;
        margin-top: 1em;
        margin-bottom: 1em;
      }
      #wrapperlicious .permalink {
        display: none;
        left: -0.75em;
        position: absolute;
        padding-right: 0.25em;
        text-decoration: none;
      }
      #wrapperlicious h1:hover .permalink, #wrapperlicious h2:hover .permalink,
      #wrapperlicious h3:hover .permalink, #wrapperlicious h4:hover .permalink,
      #wrapperlicious dt:hover .permalink {
        display: block;
      }
    </style>
    <!-- Global site tag (gtag.js) - Google Analytics -->
    <script async src="https://www.googletagmanager.com/gtag/js?id=G-KVNWBNT5FB"></script>
    <script>
      window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());

      gtag('config', 'G-KVNWBNT5FB');
      gtag('config', 'UA-50555-3');
    </script>
  </head>
  <body>
    <nav class="navbar navbar-expand-md navbar-dark bg-dark justify-content-between">
  <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation">
    <span class="navbar-toggler-icon"></span>
  </button>
  <a class="navbar-brand" href="https://perldoc.perl.org/">Perldoc Browser</a>
  <div class="collapse navbar-collapse" id="navbarNav">
    <ul class="navbar-nav mr-auto">
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="./Test2::API::InterceptResult.html#" id="dropdownlink-stable" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">5.35.0</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-stable">
          <a class="dropdown-item" href="https://perldoc.perl.org/Test2::API::InterceptResult">Latest</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.2/Test2::API::InterceptResult">5.38.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.1/Test2::API::InterceptResult">5.38.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0/Test2::API::InterceptResult">5.38.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.3/Test2::API::InterceptResult">5.36.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.2/Test2::API::InterceptResult">5.36.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.1/Test2::API::InterceptResult">5.36.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.0/Test2::API::InterceptResult">5.36.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.3/Test2::API::InterceptResult">5.34.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.2/Test2::API::InterceptResult">5.34.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.1/Test2::API::InterceptResult">5.34.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.0/Test2::API::InterceptResult">5.34.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.32.1/Test2::API::InterceptResult">5.32.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.32.0/Test2::API::InterceptResult">5.32.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.3/Test2::API::InterceptResult">5.30.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.2/Test2::API::InterceptResult">5.30.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.1/Test2::API::InterceptResult">5.30.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.0/Test2::API::InterceptResult">5.30.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.3/Test2::API::InterceptResult">5.28.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.2/Test2::API::InterceptResult">5.28.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.1/Test2::API::InterceptResult">5.28.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.0/Test2::API::InterceptResult">5.28.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.3/Test2::API::InterceptResult">5.26.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.2/Test2::API::InterceptResult">5.26.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.1/Test2::API::InterceptResult">5.26.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.0/Test2::API::InterceptResult">5.26.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.4/Test2::API::InterceptResult">5.24.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.3/Test2::API::InterceptResult">5.24.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.2/Test2::API::InterceptResult">5.24.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.1/Test2::API::InterceptResult">5.24.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.0/Test2::API::InterceptResult">5.24.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.4/Test2::API::InterceptResult">5.22.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.3/Test2::API::InterceptResult">5.22.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.2/Test2::API::InterceptResult">5.22.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.1/Test2::API::InterceptResult">5.22.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.0/Test2::API::InterceptResult">5.22.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.3/Test2::API::InterceptResult">5.20.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.2/Test2::API::InterceptResult">5.20.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.1/Test2::API::InterceptResult">5.20.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.0/Test2::API::InterceptResult">5.20.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.4/Test2::API::InterceptResult">5.18.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.3/Test2::API::InterceptResult">5.18.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.2/Test2::API::InterceptResult">5.18.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.1/Test2::API::InterceptResult">5.18.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.0/Test2::API::InterceptResult">5.18.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.3/Test2::API::InterceptResult">5.16.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.2/Test2::API::InterceptResult">5.16.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.1/Test2::API::InterceptResult">5.16.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.0/Test2::API::InterceptResult">5.16.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.4/Test2::API::InterceptResult">5.14.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.3/Test2::API::InterceptResult">5.14.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.2/Test2::API::InterceptResult">5.14.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.1/Test2::API::InterceptResult">5.14.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.0/Test2::API::InterceptResult">5.14.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.5/Test2::API::InterceptResult">5.12.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.4/Test2::API::InterceptResult">5.12.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.3/Test2::API::InterceptResult">5.12.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.2/Test2::API::InterceptResult">5.12.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.1/Test2::API::InterceptResult">5.12.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.0/Test2::API::InterceptResult">5.12.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.10.1/Test2::API::InterceptResult">5.10.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.10.0/Test2::API::InterceptResult">5.10.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.9/Test2::API::InterceptResult">5.8.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.8/Test2::API::InterceptResult">5.8.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.7/Test2::API::InterceptResult">5.8.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.6/Test2::API::InterceptResult">5.8.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.5/Test2::API::InterceptResult">5.8.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.4/Test2::API::InterceptResult">5.8.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.3/Test2::API::InterceptResult">5.8.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.2/Test2::API::InterceptResult">5.8.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.1/Test2::API::InterceptResult">5.8.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.0/Test2::API::InterceptResult">5.8.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.2/Test2::API::InterceptResult">5.6.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.1/Test2::API::InterceptResult">5.6.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.0/Test2::API::InterceptResult">5.6.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_04/Test2::API::InterceptResult">5.005_04</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_03/Test2::API::InterceptResult">5.005_03</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_02/Test2::API::InterceptResult">5.005_02</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_01/Test2::API::InterceptResult">5.005_01</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005/Test2::API::InterceptResult">5.005</a>
        </div>
      </li>
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="./Test2::API::InterceptResult.html#" id="dropdownlink-dev" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Dev</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-dev">
          <a class="dropdown-item" href="https://perldoc.perl.org/blead/Test2::API::InterceptResult">blead</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.6/Test2::API::InterceptResult">5.39.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.5/Test2::API::InterceptResult">5.39.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.4/Test2::API::InterceptResult">5.39.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.3/Test2::API::InterceptResult">5.39.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.2/Test2::API::InterceptResult">5.39.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.1/Test2::API::InterceptResult">5.39.1</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0-RC2/Test2::API::InterceptResult">5.38.0-RC2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0-RC1/Test2::API::InterceptResult">5.38.0-RC1</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.11/Test2::API::InterceptResult">5.37.11</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.10/Test2::API::InterceptResult">5.37.10</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.9/Test2::API::InterceptResult">5.37.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.8/Test2::API::InterceptResult">5.37.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.7/Test2::API::InterceptResult">5.37.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.6/Test2::API::InterceptResult">5.37.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.5/Test2::API::InterceptResult">5.37.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.4/Test2::API::InterceptResult">5.37.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.3/Test2::API::InterceptResult">5.37.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.2/Test2::API::InterceptResult">5.37.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.1/Test2::API::InterceptResult">5.37.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.0/Test2::API::InterceptResult">5.37.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.11/Test2::API::InterceptResult">5.35.11</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.10/Test2::API::InterceptResult">5.35.10</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.9/Test2::API::InterceptResult">5.35.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.8/Test2::API::InterceptResult">5.35.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.7/Test2::API::InterceptResult">5.35.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.6/Test2::API::InterceptResult">5.35.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.5/Test2::API::InterceptResult">5.35.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.4/Test2::API::InterceptResult">5.35.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.3/Test2::API::InterceptResult">5.35.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.2/Test2::API::InterceptResult">5.35.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.1/Test2::API::InterceptResult">5.35.1</a>
          <a class="dropdown-item active" href="./Test2::API::InterceptResult.html">5.35.0</a>
        </div>
      </li>
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="./Test2::API::InterceptResult.html#" id="dropdownlink-nav" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Documentation</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-nav">
          <a class="dropdown-item" href="perl.html">Perl</a>
          <a class="dropdown-item" href="perlintro.html">Intro</a>
          <a class="dropdown-item" href="perl.html#Tutorials">Tutorials</a>
          <a class="dropdown-item" href="perlfaq.html">FAQs</a>
          <a class="dropdown-item" href="perl.html#Reference-Manual">Reference</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="perlop.html">Operators</a>
          <a class="dropdown-item" href="functions.html">Functions</a>
          <a class="dropdown-item" href="variables.html">Variables</a>
          <a class="dropdown-item" href="modules.html">Modules</a>
          <a class="dropdown-item" href="perlutil.html">Utilities</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="perlcommunity.html">Community</a>
          <a class="dropdown-item" href="perlhist.html">History</a>
        </div>
      </li>
    </ul>
    <ul class="navbar-nav">
      <script>
        function set_expand (expand) {
          var perldocdiv = document.getElementById('perldocdiv');
          var width = window.getComputedStyle(perldocdiv).getPropertyValue('max-width');
          var expanded = (width == '' || width == 'none') ? true : false;
          if (expand === null) {
            expand = !expanded;
          }
          if ((expand && !expanded) || (!expand && expanded)) {
            perldocdiv.style.setProperty('max-width', expand ? 'none' : '960px');
            var button_classlist = document.getElementById('content-expand-button').classList;
            if (expand) {
              button_classlist.add('btn-light');
              button_classlist.remove('btn-outline-light');
            } else {
              button_classlist.add('btn-outline-light');
              button_classlist.remove('btn-light');
            }
          }
          return expand;
        }
        function toggle_expand () {
          var expand = set_expand(null);
          document.cookie = 'perldoc_expand=' + (expand ? 1 : 0) + '; path=/; expires=Tue, 19 Jan 2038 03:14:07 UTC';
        }
        function read_expand () {
          return document.cookie.split(';').some(function (item) { return item.indexOf('perldoc_expand=1') >= 0 });
        }
        if (document.readyState === 'loading') {
          document.addEventListener('DOMContentLoaded', function () {
            if (read_expand()) {
              set_expand(true);
            }
          });
        } else if (read_expand()) {
          set_expand(true);
        }
      </script>
      <button id="content-expand-button" type="button" class="btn btn-outline-light d-none d-lg-inline-block mr-2" onclick="toggle_expand()">Expand</button>
    <ul>
    <form class="form-inline" method="get" action="https://perldoc.perl.org/5.35.0/search">
      <input class="form-control mr-3" type="search" name="q" placeholder="Search" aria-label="Search">
    </form>
  </div>
</nav>

    <div id="wrapperlicious" class="container-fluid">
      <div id="perldocdiv">
        <div id="links">
          <a href="./Test2::API::InterceptResult.html">Test2::API::InterceptResult</a>
          <div id="more">
            (<a href="./Test2::API::InterceptResult.txt">source</a>,
            <a href="https://metacpan.org/pod/Test2::API::InterceptResult">CPAN</a>)
          </div>
            <div id="moduleversion">version 1.302183</div>
        </div>
        <div class="leading-notice">
          You are viewing the version of this documentation from Perl 5.35.0.
            This is a development version of Perl.
        </div>
        <h1><a id="toc">CONTENTS</a></h1>
                  <ul>
              <li>
                <a class="text-decoration-none" href="./Test2::API::InterceptResult.html#NAME">NAME</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Test2::API::InterceptResult.html#DESCRIPTION">DESCRIPTION</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Test2::API::InterceptResult.html#SYNOPSIS">SYNOPSIS</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Test2::API::InterceptResult.html#METHODS">METHODS</a>
                            <ul>
              <li>
                <a class="text-decoration-none" href="./Test2::API::InterceptResult.html#CONSTRUCTION">CONSTRUCTION</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Test2::API::InterceptResult.html#NORMALIZATION">NORMALIZATION</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Test2::API::InterceptResult.html#FILTERING">FILTERING</a>
                            <ul>
              <li>
                <a class="text-decoration-none" href="./Test2::API::InterceptResult.html#%25PARAMS">%PARAMS</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Test2::API::InterceptResult.html#METHODS1">METHODS</a>
              </li>
          </ul>

              </li>
              <li>
                <a class="text-decoration-none" href="./Test2::API::InterceptResult.html#MAPPING">MAPPING</a>
              </li>
          </ul>

              </li>
              <li>
                <a class="text-decoration-none" href="./Test2::API::InterceptResult.html#SOURCE">SOURCE</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Test2::API::InterceptResult.html#MAINTAINERS">MAINTAINERS</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Test2::API::InterceptResult.html#AUTHORS">AUTHORS</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Test2::API::InterceptResult.html#COPYRIGHT">COPYRIGHT</a>
              </li>
          </ul>

      <h1 id="NAME"><a class="permalink" href="./Test2::API::InterceptResult.html#NAME">#</a>NAME</h1>

<p>Test2::API::InterceptResult - Representation of a list of events.</p>

<h1 id="DESCRIPTION"><a class="permalink" href="./Test2::API::InterceptResult.html#DESCRIPTION">#</a>DESCRIPTION</h1>

<p>This class represents a list of events, normally obtained using <code>intercept()</code> from <a href="./Test2::API.html">Test2::API</a>.</p>

<p>This class is intended for people who with to verify the results of test tools they write.</p>

<p>This class provides methods to normalize, summarize, or map the list of events. The output of these operations makes verifying your testing tools and the events they generate significantly easier. In most cases this spares you from needing a deep understanding of the event/facet model.</p>

<h1 id="SYNOPSIS"><a class="permalink" href="./Test2::API::InterceptResult.html#SYNOPSIS">#</a>SYNOPSIS</h1>

<p>Usually you get an instance of this class when you use <code>intercept()</code> from <a href="./Test2::API.html">Test2::API</a>.</p>

<pre><code>use Test2::V0;
use Test2::API qw/intercept/;

my $events = intercept {
    ok(1, &quot;pass&quot;);
    ok(0, &quot;fail&quot;);
    todo &quot;broken&quot; =&gt; sub { ok(0, &quot;fixme&quot;) };
    plan 3;
};

# This is typically the most useful construct
# squash_info() merges assertions and diagnostics that are associated
#   (and returns a new instance with the modifications)
# flatten() condenses the facet data into the key details for each event
#   (and returns those structures in an arrayref)
is(
    $events-&gt;squash_info-&gt;flatten(),
    [
        {
            causes_failure =&gt; 0,

            name =&gt; &#39;pass&#39;,
            pass =&gt; 1,

            trace_file =&gt; &#39;xxx.t&#39;,
            trace_line =&gt; 5,
        },
        {
            causes_failure =&gt; 1,

            name =&gt; &#39;fail&#39;,
            pass =&gt; 0,

            trace_file =&gt; &#39;xxx.t&#39;,
            trace_line =&gt; 6,

            # There can be more than one diagnostics message so this is
            # always an array when present.
            diag =&gt; [&quot;Failed test &#39;fail&#39;\nat xxx.t line 6.&quot;],
        },
        {
            causes_failure =&gt; 0,

            name =&gt; &#39;fixme&#39;,
            pass =&gt; 0,

            trace_file =&gt; &#39;xxx.t&#39;,
            trace_line =&gt; 7,

            # There can be more than one diagnostics message or todo
            # reason, so these are always an array when present.
            todo =&gt; [&#39;broken&#39;],

            # Diag message was turned into a note since the assertion was
            # TODO
            note =&gt; [&quot;Failed test &#39;fixme&#39;\nat xxx.t line 7.&quot;],
        },
        {
            causes_failure =&gt; 0,

            plan =&gt; 3,

            trace_file =&gt; &#39;xxx.t&#39;,
            trace_line =&gt; 8,
        },
    ],
    &quot;Flattened events look like we expect&quot;
);</code></pre>

<p>See <a href="./Test2::API::InterceptResult::Event.html">Test2::API::InterceptResult::Event</a> for a full description of what <code>flatten()</code> provides for each event.</p>

<h1 id="METHODS"><a class="permalink" href="./Test2::API::InterceptResult.html#METHODS">#</a>METHODS</h1>

<p>Please note that no methods modify the original instance unless asked to do so.</p>

<h2 id="CONSTRUCTION"><a class="permalink" href="./Test2::API::InterceptResult.html#CONSTRUCTION">#</a>CONSTRUCTION</h2>

<dl>

<dt id="$events-=-Test2::API::InterceptResult-&gt;new(@EVENTS)"><a class="permalink" href="./Test2::API::InterceptResult.html#$events-=-Test2::API::InterceptResult-%3Enew(@EVENTS)">#</a><a id="events-Test2::API::InterceptResult-new-EVENTS"></a>$events = Test2::API::InterceptResult-&gt;new(@EVENTS)</dt>
<dd>

</dd>
<dt id="$events-=-Test2::API::InterceptResult-&gt;new_from_ref(\@EVENTS)"><a class="permalink" href="./Test2::API::InterceptResult.html#$events-=-Test2::API::InterceptResult-%3Enew_from_ref(%5C@EVENTS)">#</a><a id="events-Test2::API::InterceptResult-new_from_ref-EVENTS"></a>$events = Test2::API::InterceptResult-&gt;new_from_ref(\@EVENTS)</dt>
<dd>

<p>These create a new instance of Test2::API::InterceptResult from the given events.</p>

<p>In the first form a new blessed arrayref is returned. In the &#39;new_from_ref&#39; form the reference you pass in is directly blessed.</p>

<p>Both of these will throw an exception if called in void context. This is mainly important for the &#39;filtering&#39; methods listed below which normally return a new instance, they throw an exception in such cases as it probably means someone meant to filter the original in place.</p>

</dd>
<dt id="$clone-=-$events-&gt;clone()"><a class="permalink" href="./Test2::API::InterceptResult.html#$clone-=-$events-%3Eclone()">#</a><a id="clone-events-clone"></a>$clone = $events-&gt;clone()</dt>
<dd>

<p>Make a clone of the original events. Note that this is a deep copy, the entire structure is duplicated. This uses <code>dclone</code> from <a href="Storable.html">Storable</a> to achieve the deep clone.</p>

</dd>
</dl>

<h2 id="NORMALIZATION"><a class="permalink" href="./Test2::API::InterceptResult.html#NORMALIZATION">#</a>NORMALIZATION</h2>

<dl>

<dt id="@events-=-$events-&gt;event_list"><a class="permalink" href="./Test2::API::InterceptResult.html#@events-=-$events-%3Eevent_list">#</a><a id="events-events-event_list"></a>@events = $events-&gt;event_list</dt>
<dd>

<p>This returns all the events in list-form.</p>

</dd>
<dt id="$hub-=-$events-&gt;hub"><a class="permalink" href="./Test2::API::InterceptResult.html#$hub-=-$events-%3Ehub">#</a><a id="hub-events-hub"></a>$hub = $events-&gt;hub</dt>
<dd>

<p>This returns a new <a href="./Test2::Hub.html">Test2::Hub</a> instance that has processed all the events contained in the instance. This gives you a simple way to inspect the state changes your events cause.</p>

</dd>
<dt id="$state-=-$events-&gt;state"><a class="permalink" href="./Test2::API::InterceptResult.html#$state-=-$events-%3Estate">#</a><a id="state-events-state"></a>$state = $events-&gt;state</dt>
<dd>

<p>This returns a summary of the state of a hub after processing all the events.</p>

<pre><code>{
    count        =&gt; 2,      # Number of assertions made
    failed       =&gt; 1,      # Number of test failures seen
    is_passing   =&gt; 0,      # Boolean, true if the test would be passing
                            # after the events are processed.

    plan         =&gt; 2,      # Plan, either a number, undef, &#39;SKIP&#39;, or &#39;NO PLAN&#39;
    follows_plan =&gt; 1,      # True if there is a plan and it was followed.
                            # False if the plan and assertions did not
                            # match, undef if no plan was present in the
                            # event list.

    bailed_out   =&gt; undef,  # undef unless there was a bail-out in the
                            # events in which case this will be a string
                            # explaining why there was a bailout, if no
                            # reason was given this will simply be set to
                            # true (1).

    skip_reason  =&gt; undef,  # If there was a skip_all this will give the
                            # reason.
}</code></pre>

</dd>
<dt id="$new-=-$events-&gt;upgrade"><a class="permalink" href="./Test2::API::InterceptResult.html#$new-=-$events-%3Eupgrade">#</a><a id="new-events-upgrade"></a>$new = $events-&gt;upgrade</dt>
<dd>

</dd>
<dt id="$events-&gt;upgrade(in_place-=&gt;-$BOOL)"><a class="permalink" href="./Test2::API::InterceptResult.html#$events-%3Eupgrade(in_place-=%3E-$BOOL)">#</a><a id="upgrade"></a><a id="events-upgrade-in_place-BOOL"></a>$events-&gt;upgrade(in_place =&gt; $BOOL)</dt>
<dd>

<p><b>Note:</b> This normally returns a new instance, leaving the original unchanged. If you call it in void context it will throw an exception. If you want to modify the original you must pass in the <code>in_place =&gt; 1</code> option. You may call this in void context when you ask to modify it in place. The in-place form returns the instance that was modified so you can chain methods.</p>

<p>This will create a clone of the list where all events have been converted into <a href="./Test2::API::InterceptResult::Event.html">Test2::API::InterceptResult::Event</a> instances. This is extremely helpful as <a href="./Test2::API::InterceptResult::Event.html">Test2::API::InterceptResult::Event</a> provide a much better interface for working with events. This allows you to avoid thinking about legacy event types.</p>

<p>This also means your tests against the list are not fragile if the tool you are testing randomly changes what type of events it generates (IE Changing from <a href="./Test2::Event::Ok.html">Test2::Event::Ok</a> to <a href="./Test2::Event::Pass.html">Test2::Event::Pass</a>, both make assertions and both will normalize to identical (or close enough) <a href="./Test2::API::InterceptResult::Event.html">Test2::API::InterceptResult::Event</a> instances.</p>

<p>Really you almost always want this, the only reason it is not done automatically is to make sure the <code>intercept()</code> tool is backwards compatible.</p>

</dd>
<dt id="$new-=-$events-&gt;squash_info"><a class="permalink" href="./Test2::API::InterceptResult.html#$new-=-$events-%3Esquash_info">#</a><a id="new-events-squash_info"></a>$new = $events-&gt;squash_info</dt>
<dd>

</dd>
<dt id="$events-&gt;squash_info(in_place-=&gt;-$BOOL)"><a class="permalink" href="./Test2::API::InterceptResult.html#$events-%3Esquash_info(in_place-=%3E-$BOOL)">#</a><a id="squash_info"></a><a id="events-squash_info-in_place-BOOL"></a>$events-&gt;squash_info(in_place =&gt; $BOOL)</dt>
<dd>

<p><b>Note:</b> This normally returns a new instance, leaving the original unchanged. If you call it in void context it will throw an exception. If you want to modify the original you must pass in the <code>in_place =&gt; 1</code> option. You may call this in void context when you ask to modify it in place. The in-place form returns the instance that was modified so you can chain methods.</p>

<p><b>Note:</b> All events in the new or modified instance will be converted to <a href="./Test2::API::InterceptResult::Event.html">Test2::API::InterceptResult::Event</a> instances. There is no way to avoid this, the squash operation requires the upgraded event class.</p>

<p><a href="./Test::More.html">Test::More</a> and many other legacy tools would send notes, diags, and assertions as seperate events. A subtest in <a href="./Test::More.html">Test::More</a> would send a note with the subtest name, the subtest assertion, and finally a diagnostics event if the subtest failed. This method will normalize things by squashing the note and diag into the same event as the subtest (This is different from putting them into the subtest, which is not what happens).</p>

</dd>
</dl>

<h2 id="FILTERING"><a class="permalink" href="./Test2::API::InterceptResult.html#FILTERING">#</a>FILTERING</h2>

<p><b>Note:</b> These normally return new instances, leaving the originals unchanged. If you call them in void context they will throw exceptions. If you want to modify the originals you must pass in the <code>in_place =&gt; 1</code> option. You may call these in void context when you ask to modify them in place. The in-place forms return the instance that was modified so you can chain methods.</p>

<h3 id="%PARAMS"><a class="permalink" href="./Test2::API::InterceptResult.html#%25PARAMS">#</a><a id="PARAMS"></a>%PARAMS</h3>

<p>These all accept the same 2 optional parameters:</p>

<dl>

<dt id="in_place-=&gt;-$BOOL"><a class="permalink" href="./Test2::API::InterceptResult.html#in_place-=%3E-$BOOL">#</a><a id="in_place"></a><a id="in_place-BOOL"></a>in_place =&gt; $BOOL</dt>
<dd>

<p>When true the method will modify the instance in place instead of returning a new instance.</p>

</dd>
<dt id="args-=&gt;-\@ARGS"><a class="permalink" href="./Test2::API::InterceptResult.html#args-=%3E-%5C@ARGS">#</a><a id="args"></a><a id="args-ARGS"></a>args =&gt; \@ARGS</dt>
<dd>

<p>If you wish to pass parameters into the event method being used for filtering, you may do so here.</p>

</dd>
</dl>

<h3 id="METHODS1"><a class="permalink" href="./Test2::API::InterceptResult.html#METHODS1">#</a>METHODS</h3>

<dl>

<dt id="$events-&gt;grep($CALL,-%PARAMS)"><a class="permalink" href="./Test2::API::InterceptResult.html#$events-%3Egrep($CALL,-%25PARAMS)">#</a><a id="grep"></a><a id="events-grep-CALL-PARAMS"></a>$events-&gt;grep($CALL, %PARAMS)</dt>
<dd>

<p>This is essentially:</p>

<pre><code>Test2::API::InterceptResult-&gt;new(
    grep { $_-&gt;$CALL( @{$PARAMS{args}} ) } $self-&gt;event_list,
);</code></pre>

<p><b>Note:</b> that $CALL is called on an upgraded version of the event, though the events returned will be the original ones, not the upgraded ones.</p>

<p>$CALL may be either the name of a method on <a href="./Test2::API::InterceptResult::Event.html">Test2::API::InterceptResult::Event</a>, or a coderef.</p>

</dd>
<dt id="$events-&gt;asserts(%PARAMS)"><a class="permalink" href="./Test2::API::InterceptResult.html#$events-%3Easserts(%25PARAMS)">#</a><a id="asserts"></a><a id="events-asserts-PARAMS"></a>$events-&gt;asserts(%PARAMS)</dt>
<dd>

<p>This is essentially:</p>

<pre><code>$events-&gt;grep(has_assert =&gt; @{$PARAMS{args}})</code></pre>

<p>It returns a new instance containing only the events that made assertions.</p>

</dd>
<dt id="$events-&gt;subtests(%PARAMS)"><a class="permalink" href="./Test2::API::InterceptResult.html#$events-%3Esubtests(%25PARAMS)">#</a><a id="subtests"></a><a id="events-subtests-PARAMS"></a>$events-&gt;subtests(%PARAMS)</dt>
<dd>

<p>This is essentially:</p>

<pre><code>$events-&gt;grep(has_subtest =&gt; @{$PARAMS{args}})</code></pre>

<p>It returns a new instance containing only the events that have subtests.</p>

</dd>
<dt id="$events-&gt;diags(%PARAMS)"><a class="permalink" href="./Test2::API::InterceptResult.html#$events-%3Ediags(%25PARAMS)">#</a><a id="diags"></a><a id="events-diags-PARAMS"></a>$events-&gt;diags(%PARAMS)</dt>
<dd>

<p>This is essentially:</p>

<pre><code>$events-&gt;grep(has_diags =&gt; @{$PARAMS{args}})</code></pre>

<p>It returns a new instance containing only the events that have diags.</p>

</dd>
<dt id="$events-&gt;notes(%PARAMS)"><a class="permalink" href="./Test2::API::InterceptResult.html#$events-%3Enotes(%25PARAMS)">#</a><a id="notes"></a><a id="events-notes-PARAMS"></a>$events-&gt;notes(%PARAMS)</dt>
<dd>

<p>This is essentially:</p>

<pre><code>$events-&gt;grep(has_notes =&gt; @{$PARAMS{args}})</code></pre>

<p>It returns a new instance containing only the events that have notes.</p>

</dd>
<dt id="$events-&gt;errors(%PARAMS)"><a class="permalink" href="./Test2::API::InterceptResult.html#$events-%3Eerrors(%25PARAMS)">#</a><a id="errors"></a><a id="events-errors-PARAMS"></a>$events-&gt;errors(%PARAMS)</dt>
<dd>

<p><b>Note:</b> Errors are NOT failing assertions. Failing assertions are a different thing.</p>

<p>This is essentially:</p>

<pre><code>$events-&gt;grep(has_errors =&gt; @{$PARAMS{args}})</code></pre>

<p>It returns a new instance containing only the events that have errors.</p>

</dd>
<dt id="$events-&gt;plans(%PARAMS)"><a class="permalink" href="./Test2::API::InterceptResult.html#$events-%3Eplans(%25PARAMS)">#</a><a id="plans"></a><a id="events-plans-PARAMS"></a>$events-&gt;plans(%PARAMS)</dt>
<dd>

<p>This is essentially:</p>

<pre><code>$events-&gt;grep(has_plan =&gt; @{$PARAMS{args}})</code></pre>

<p>It returns a new instance containing only the events that set the plan.</p>

</dd>
<dt id="$events-&gt;causes_fail(%PARAMS)"><a class="permalink" href="./Test2::API::InterceptResult.html#$events-%3Ecauses_fail(%25PARAMS)">#</a><a id="causes_fail"></a><a id="events-causes_fail-PARAMS"></a>$events-&gt;causes_fail(%PARAMS)</dt>
<dd>

</dd>
<dt id="$events-&gt;causes_failure(%PARAMS)"><a class="permalink" href="./Test2::API::InterceptResult.html#$events-%3Ecauses_failure(%25PARAMS)">#</a><a id="causes_failure"></a><a id="events-causes_failure-PARAMS"></a>$events-&gt;causes_failure(%PARAMS)</dt>
<dd>

<p>These are essentially:</p>

<pre><code>$events-&gt;grep(causes_fail    =&gt; @{$PARAMS{args}})
$events-&gt;grep(causes_failure =&gt; @{$PARAMS{args}})</code></pre>

<p><b>Note:</b> <code>causes_fail()</code> and <code>causes_failure()</code> are both aliases for eachother in events, so these methods are effectively aliases here as well.</p>

<p>It returns a new instance containing only the events that cause failure.</p>

</dd>
</dl>

<h2 id="MAPPING"><a class="permalink" href="./Test2::API::InterceptResult.html#MAPPING">#</a>MAPPING</h2>

<p>These methods <b>ALWAYS</b> return an arrayref.</p>

<p><b>Note:</b> No methods on <a href="./Test2::API::InterceptResult::Event.html">Test2::API::InterceptResult::Event</a> alter the event in any way.</p>

<p><b>Important Notes about Events</b>:</p>

<p><a href="./Test2::API::InterceptResult::Event.html">Test2::API::InterceptResult::Event</a> was tailor-made to be used in event-lists. Most methods that are not applicable to a given event will return an empty list, so you normally do not need to worry about unwanted <code>undef</code> values or exceptions being thrown. Mapping over event methods is an entended use, so it works well to produce lists.</p>

<p><b>Exceptions to the rule:</b></p>

<p>Some methods such as <code>causes_fail</code> always return a boolean true or false for all events. Any method prefixed with <code>the_</code> conveys the intent that the event should have exactly 1 of something, so those will throw an exception when that condition is not true.</p>

<dl>

<dt id="$arrayref-=-$events-&gt;map($CALL,-%PARAMS)"><a class="permalink" href="./Test2::API::InterceptResult.html#$arrayref-=-$events-%3Emap($CALL,-%25PARAMS)">#</a><a id="arrayref-events-map-CALL-PARAMS"></a>$arrayref = $events-&gt;map($CALL, %PARAMS)</dt>
<dd>

<p>This is essentially:</p>

<pre><code>[ map { $_-&gt;$CALL(@{ $PARAMS{args} }) } $events-&gt;upgrade-&gt;event_list ];</code></pre>

<p>$CALL may be either the name of a method on <a href="./Test2::API::InterceptResult::Event.html">Test2::API::InterceptResult::Event</a>, or a coderef.</p>

</dd>
<dt id="$arrayref-=-$events-&gt;flatten(%PARAMS)"><a class="permalink" href="./Test2::API::InterceptResult.html#$arrayref-=-$events-%3Eflatten(%25PARAMS)">#</a><a id="arrayref-events-flatten-PARAMS"></a>$arrayref = $events-&gt;flatten(%PARAMS)</dt>
<dd>

<p>This is essentially:</p>

<pre><code>[ map { $_-&gt;flatten(@{ $PARAMS{args} }) } $events-&gt;upgrade-&gt;event_list ];</code></pre>

<p>It returns a new list of flattened structures.</p>

<p>See <a href="./Test2::API::InterceptResult::Event.html">Test2::API::InterceptResult::Event</a> for details on what <code>flatten()</code> returns.</p>

</dd>
<dt id="$arrayref-=-$events-&gt;briefs(%PARAMS)"><a class="permalink" href="./Test2::API::InterceptResult.html#$arrayref-=-$events-%3Ebriefs(%25PARAMS)">#</a><a id="arrayref-events-briefs-PARAMS"></a>$arrayref = $events-&gt;briefs(%PARAMS)</dt>
<dd>

<p>This is essentially:</p>

<pre><code>[ map { $_-&gt;briefs(@{ $PARAMS{args} }) } $events-&gt;upgrade-&gt;event_list ];</code></pre>

<p>It returns a new list of event briefs.</p>

<p>See <a href="./Test2::API::InterceptResult::Event.html">Test2::API::InterceptResult::Event</a> for details on what <code>brief()</code> returns.</p>

</dd>
<dt id="$arrayref-=-$events-&gt;summaries(%PARAMS)"><a class="permalink" href="./Test2::API::InterceptResult.html#$arrayref-=-$events-%3Esummaries(%25PARAMS)">#</a><a id="arrayref-events-summaries-PARAMS"></a>$arrayref = $events-&gt;summaries(%PARAMS)</dt>
<dd>

<p>This is essentially:</p>

<pre><code>[ map { $_-&gt;summaries(@{ $PARAMS{args} }) } $events-&gt;upgrade-&gt;event_list ];</code></pre>

<p>It returns a new list of event summaries.</p>

<p>See <a href="./Test2::API::InterceptResult::Event.html">Test2::API::InterceptResult::Event</a> for details on what <code>summary()</code> returns.</p>

</dd>
<dt id="$arrayref-=-$events-&gt;subtest_results(%PARAMS)"><a class="permalink" href="./Test2::API::InterceptResult.html#$arrayref-=-$events-%3Esubtest_results(%25PARAMS)">#</a><a id="arrayref-events-subtest_results-PARAMS"></a>$arrayref = $events-&gt;subtest_results(%PARAMS)</dt>
<dd>

<p>This is essentially:</p>

<pre><code>[ map { $_-&gt;subtest_result(@{ $PARAMS{args} }) } $events-&gt;upgrade-&gt;event_list ];</code></pre>

<p>It returns a new list of event summaries.</p>

<p>See <a href="./Test2::API::InterceptResult::Event.html">Test2::API::InterceptResult::Event</a> for details on what <code>subtest_result()</code> returns.</p>

</dd>
<dt id="$arrayref-=-$events-&gt;diag_messages(%PARAMS)"><a class="permalink" href="./Test2::API::InterceptResult.html#$arrayref-=-$events-%3Ediag_messages(%25PARAMS)">#</a><a id="arrayref-events-diag_messages-PARAMS"></a>$arrayref = $events-&gt;diag_messages(%PARAMS)</dt>
<dd>

<p>This is essentially:</p>

<pre><code>[ map { $_-&gt;diag_messages(@{ $PARAMS{args} }) } $events-&gt;upgrade-&gt;event_list ];</code></pre>

<p>It returns a new list of diagnostic messages (strings).</p>

<p>See <a href="./Test2::API::InterceptResult::Event.html">Test2::API::InterceptResult::Event</a> for details on what <code>diag_messages()</code> returns.</p>

</dd>
<dt id="$arrayref-=-$events-&gt;note_messages(%PARAMS)"><a class="permalink" href="./Test2::API::InterceptResult.html#$arrayref-=-$events-%3Enote_messages(%25PARAMS)">#</a><a id="arrayref-events-note_messages-PARAMS"></a>$arrayref = $events-&gt;note_messages(%PARAMS)</dt>
<dd>

<p>This is essentially:</p>

<pre><code>[ map { $_-&gt;note_messages(@{ $PARAMS{args} }) } $events-&gt;upgrade-&gt;event_list ];</code></pre>

<p>It returns a new list of notification messages (strings).</p>

<p>See <a href="./Test2::API::InterceptResult::Event.html">Test2::API::InterceptResult::Event</a> for details on what <code>note_messages()</code> returns.</p>

</dd>
<dt id="$arrayref-=-$events-&gt;error_messages(%PARAMS)"><a class="permalink" href="./Test2::API::InterceptResult.html#$arrayref-=-$events-%3Eerror_messages(%25PARAMS)">#</a><a id="arrayref-events-error_messages-PARAMS"></a>$arrayref = $events-&gt;error_messages(%PARAMS)</dt>
<dd>

<p>This is essentially:</p>

<pre><code>[ map { $_-&gt;error_messages(@{ $PARAMS{args} }) } $events-&gt;upgrade-&gt;event_list ];</code></pre>

<p>It returns a new list of error messages (strings).</p>

<p>See <a href="./Test2::API::InterceptResult::Event.html">Test2::API::InterceptResult::Event</a> for details on what <code>error_messages()</code> returns.</p>

</dd>
</dl>

<h1 id="SOURCE"><a class="permalink" href="./Test2::API::InterceptResult.html#SOURCE">#</a>SOURCE</h1>

<p>The source code repository for Test2 can be found at <i>http://github.com/Test-More/test-more/</i>.</p>

<h1 id="MAINTAINERS"><a class="permalink" href="./Test2::API::InterceptResult.html#MAINTAINERS">#</a>MAINTAINERS</h1>

<dl>

<dt id="Chad-Granum"><a class="permalink" href="./Test2::API::InterceptResult.html#Chad-Granum">#</a><a id="Chad-Granum-&lt;exodist@cpan.org&gt;"></a><a id="Chad"></a><a id="Chad-Granum-exodist-cpan.org"></a>Chad Granum &lt;exodist@cpan.org&gt;</dt>
<dd>

</dd>
</dl>

<h1 id="AUTHORS"><a class="permalink" href="./Test2::API::InterceptResult.html#AUTHORS">#</a>AUTHORS</h1>

<dl>

<dt id="Chad-Granum1"><a class="permalink" href="./Test2::API::InterceptResult.html#Chad-Granum1">#</a><a id="Chad-Granum-&lt;exodist@cpan.org&gt;1"></a><a id="Chad1"></a><a id="Chad-Granum-exodist-cpan.org1"></a>Chad Granum &lt;exodist@cpan.org&gt;</dt>
<dd>

</dd>
</dl>

<h1 id="COPYRIGHT"><a class="permalink" href="./Test2::API::InterceptResult.html#COPYRIGHT">#</a>COPYRIGHT</h1>

<p>Copyright 2020 Chad Granum &lt;exodist@cpan.org&gt;.</p>

<p>This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.</p>

<p>See <i>http://dev.perl.org/licenses/</i></p>


      </div>
      <div id="footer">
        <p>Perldoc Browser is maintained by Dan Book (<a href="https://metacpan.org/author/DBOOK">DBOOK</a>). Please contact him via the <a href="https://github.com/Grinnz/perldoc-browser/issues">GitHub issue tracker</a> or <a href="mailto:dbook@cpan.org">email</a> regarding any issues with the site itself, search, or rendering of documentation.</p>

<p>The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via the <a href="https://github.com/Perl/perl5/issues">Perl issue tracker</a>, the <a href="https://lists.perl.org/list/perl5-porters.html">mailing list</a>, or <a href="https://kiwiirc.com/client/irc.perl.org/p5p">IRC</a> to report any issues with the contents or format of the documentation.</p>


      </div>
    </div>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.slim.min.js" integrity="sha512-/DXTXr6nQodMUiq+IUJYCt2PPOUjrHJ9wFrqpJ3XkgPNOZVfMok7cRw6CSxyCQxXn6ozlESsSh1/sMCTF1rL/g==" crossorigin="anonymous"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.16.1/umd/popper.min.js" integrity="sha512-ubuT8Z88WxezgSqf3RLuNi5lmjstiJcyezx34yIU2gAHonIi27Na7atqzUZCOoY4CExaoFumzOsFQ2Ch+I/HCw==" crossorigin="anonymous"></script>
    <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/js/bootstrap.min.js" integrity="sha384-B4gt1jrGC7Jh4AgTPSdUtOBvfO8shuf57BaghqFfPlYxofvL8/KUEfYiJOMMV+rV" crossorigin="anonymous"></script>
    <script src="../highlight.pack.js"></script>
    <script>hljs.highlightAll();</script>
  </body>
</html>
